royalty
对象在订单付款完成或退款完成后由 Ping++ 自动生成,根据订单中的分润信息或分润模板生成的清分数据。royalty
对象会在分润发起方和分润接收方关联的 app
下同时生成。royalty
对象中,分润发起方的 amount 为负值,分润接收方的 amount 为正值。
注:此接口需要使用创建 Order 时收款方(receipt_app
)的APIKey
和私钥请求 API 接口
属性 | 描述 |
---|---|
id string | 分润对象 ID ,由 Ping++ 生成。 |
object string | 值为 "royalty"。 |
payer_app string | 分润发起方对应的 app 对象的 id 。 |
created timestamp | 创建时间,用 Unix 时间戳表示。 |
livemode boolean | 是否处于 live 模式。 |
status string | 分润状态。值为 created :入账、pending :结算发起、waiting :结算汇总、succeeded :结算成功。 |
amount integer | 分润金额,单位为分。数值带符号,其中负值表示支出、正值表示收入。 |
method string | 分润方式。目前支持渠道:wx_pub (微信 JSAPI)、wx_lite (微信小程序)、alipay (支付宝)、unionpay (银联)、allinpay (通联)和 jdpay (京东)、balance (余额),以及manual (手动标记)。 |
recipient_app string | 分润接收方的 app 对象的 id 。 |
royalty_transaction string | 关联的 royalty_transaction 对象的 id 。 |
royalty_settlement string | 关联的 royalty_settlement 对象的 id 。 |
time_settled string | 结算成功时间,用 Unix 时间戳表示。 |
settle_account string | 关联的 settle_account 对象的 id ,表示该分润结算对应用户结算账户。 |
source_app string | 平台的 app 对象的 id 。 |
source_url string | 关联对象的请求地址,目前支持 order 对象,例如:"/v1/orders/{ORDER_ID}"。 |
source_no string | 关联对象的 order_no 。 |
source_user string | 分润接收方 user 对象的 id 。 |
description string | 附加说明,最多 255 个 Unicode 字符。 |
metadata optional | 详见 元数据。 |
{ "object": "list", "url": "/v1/royalties", "has_more": false, "data": [ { "id": "170301124238000111", "object": "royalty", "payer_app": "app_1Gqj58ynP0mHeX1q", "amount": -1, "created": 1488343358, "description": "Your description", "livemode": true, "metadata": {}, "method": "manual", "recipient_app": null, "royalty_transaction": null, "royalty_settlement": null, "source_app": "app_1Gqj58ynP0mHeX1q", "source_no": "12345678", "source_url": "/v1/orders/2011609010000025991", "source_user": "user_001", "status": "succeeded", "settle_account": null, "time_settled": 1488465301 }, {...}, {...} ] }